home *** CD-ROM | disk | FTP | other *** search
/ Pluspack 1 / Caligari Corporation Pluspack1 1998.iso / TSX_SDK / tsxINC / tsxMouse.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-01-28  |  4.6 KB  |  109 lines
  1. //******************************************************************************
  2. //    File: tsxMouse.h
  3. //  Module: trueSpace eXtensions API
  4. //   Descr: Interface to the Mouse
  5. //******************************************************************************
  6.  
  7. #ifndef TSXMOUSE_H
  8. #define TSXMOUSE_H
  9.  
  10.  
  11. #include "tsxTypes.h"
  12.  
  13.  
  14. //------------------------------------------------------------------------------
  15. //------------------------------------------------------------------------------
  16.  
  17. // This is the interface to the Mouse-Tool in trueSpace.
  18. // For an extension to receive mouse action messages, it must install
  19. // the mouse-tool (using tsxMtoolInstall).
  20. // See also picking functions in "tsxAView.h".
  21.  
  22. //------------------------------------------------------------------------------
  23. //    Related Types and Definitions
  24. //------------------------------------------------------------------------------
  25.  
  26. // Internal data structure for managing the mouse tool.
  27. struct tsxMousetool {};
  28.  
  29. // Callback type for mouse-tool message
  30. typedef BOOL (*tsxMtoolMsg)(
  31.     tsxMousetool *mt,
  32.     short msg,     //see mouse-tool messages, below.
  33.     short x,       //mouse position on screen, viewport X coordinate.
  34.     short y,       //mouse position on screen, viewport Y coordinate.
  35.     short data     //additional data depending upon msg.
  36.     );
  37. // Callback type for mouse events
  38. typedef BOOL (*tsxMtoolClick)(
  39.     tsxMousetool *mt,
  40.     short x,       //mouse position on screen, viewport X coordinate.
  41.     short y,       //mouse position on screen, viewport Y coordinate.
  42.     short flags //see mouse event flags, below.
  43.     );
  44.  
  45. // Mouse-tool messages
  46. #define tsxMTM_ACTIVATE      1 //Mousetool is being activated.
  47. #define tsxMTM_DEACTIVATE 2 //Mousetool is being deactivated.
  48. #define tsxMTM_DESELECT      3 //Current object is being deselected.
  49. #define tsxMTM_SELECT      4 //New current object has been selected.
  50. #define tsxMTM_KEY      5 //Key has been pressed: char is in `data'.
  51.                             // Return FALSE if key is used.
  52. #define tsxMTM_CREATE      6 //Mousetool has been created.
  53. #define tsxMTM_DESTROY      7 //Mousetool is being destroyed.
  54. #define tsxMTM_ERASE      8 //Erase requested on currently selected object.
  55.                 // If TRUE is returned the current object is deleted.
  56. #define tsxMTM_CHECKCURSOR 9 //Called on WM_MOUSEMOVE, WM_KEYUP, WM_KEYDOWN.
  57.                  // `data' contains mouse event flags.
  58.                  // For Mouse-move, mouse coordinates are passed.
  59.  
  60. // Mouse event flags
  61. #define tsxMTF_RIGHT     0x01 //Right mouse button clicked
  62. #define tsxMTF_LEFT      0x02 //Left mouse button clicked
  63. #define tsxMTF_SHIFT     0x04 //Shift key is pressed
  64. #define tsxMTF_CTRL     0x08 //Control key is pressed
  65. #define tsxMTF_OUTSIDE 0x4000 //Mouse is outside window (for drag operations)
  66. #define tsxMTF_DBLCLK  0x8000 //Mouse button was double-clicked
  67.  
  68.  
  69. //------------------------------------------------------------------------------
  70. //    Management
  71. //------------------------------------------------------------------------------
  72.  
  73. // When a new mouse-tool is installed, `pMtoolMsgFunc' is called with the
  74. // message tsxMTM_CREATE, and then with tsxMTM_ACTIVATE. The eXtension
  75. // MUST be active at this time.
  76. // A mouse-tool installed by an extension is removed before the extension is
  77. // deactivated. It is also removed when trueSpace receives a new install request.
  78. // Before a mouse-tool is removed, its message function `pMtoolMsgFunc' is
  79. // called first with the message tsxMTM_DEACTIVATE and then with tsxMTM_DESTROY.
  80. // 
  81. // Typical sequence of events:
  82. //    - User selects eXtn
  83. //    - eXtn is activated
  84. //    - eXtn installs mouse-tool
  85. //    - pMtoolMsgFunc called with message tsxMTM_CREATE
  86. //    - pMtoolMsgFunc called with message tsxMTM_ACTIVATE
  87. //    - ... handle mouse events ...
  88. //    - user selects another tS tool
  89. //    - pMtoolMsgFunc called with message tsxMTM_DEACTIVATE
  90. //    - pMtoolMsgFunc called with message tsxMTM_DESTROY
  91. //    - eXtn is deactivated (tsxDeactivate)
  92. //    - control switches to the new tool selected by user
  93.  
  94. // Installs the mouse-tool if the eXtension is active.
  95. // Function pointers cannot be NULL.
  96. TSXAPIFN tsxERR tsxMtoolInstall(
  97.     int tsxid,               // extension-id (see tsxGetData)
  98.     tsxMtoolMsg pMtoolMsgFunc,       // mouse-tool-message callback
  99.     tsxMtoolClick pMtoolEventFunc  // mouse-event callback
  100.     );
  101.  
  102. // Removes the mouse-tool installed by this extension, if any.
  103. // Extension must be active.
  104. TSXAPIFN void tsxMtoolRemove( int tsxid );
  105.  
  106.  
  107. //******************************************************************************
  108. #endif // TSXMOUSE_H
  109.